package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.MemoConfigAddDTO;
import org.jsola.hr.dto.MemoConfigUpdateDTO;
import org.jsola.hr.query.MemoConfigQuery;
import org.jsola.hr.vo.MemoConfigListVO;
import org.jsola.hr.vo.MemoConfigVO;

import java.util.List;

/**
 * 备忘录配置
 *
 * @author zhr
 */
@Api(tags = "hr-备忘录配置")
public interface IMemoConfigControllerAPI {

    /**
     * 新增备忘录配置
     * @param memoConfigAddDTO 备忘录配置新增实体
     * @return 备忘录配置展示对象
     */
    @ApiOperation(value = "新增备忘录配置")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "memoConfigAddDTO", dataType = "MemoConfigAddDTO", value = "新增备忘录配置", paramType = "body")
    })
    Result<MemoConfigVO> save(MemoConfigAddDTO memoConfigAddDTO);


    /**
     * 修改备忘录配置
     * @param memoConfigUpdateDTO 备忘录配置
     * @return 更新数量
     */
    @ApiOperation(value = "修改备忘录配置")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "memoConfigUpdateDTO", dataType = "MemoConfigUpdateDTO", value = "修改备忘录配置", paramType = "body")
    })
    Result<Integer> update(MemoConfigUpdateDTO memoConfigUpdateDTO);




    /**
     * 删除单个备忘录配置，彻底删除
     * @param memoConfigId 备忘录配置id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个备忘录配置，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "memoConfigId", dataType = "String", value = "备忘录配置id", paramType = "path")
    })
    Result<Integer> delete(String memoConfigId);


    /**
     * 批量删除备忘录配置，彻底删除
     * @param memoConfigIds 备忘录配置id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除备忘录配置，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "memoConfigIds", dataType = "String[]", value = "备忘录配置id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] memoConfigIds);


    /**
     * 根据备忘录配置id查询备忘录配置详情
     * @param memoConfigId 备忘录配置id
     * @return 备忘录配置详情
     */
    @ApiOperation(value="根据备忘录配置id查询备忘录配置详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "memoConfigId", dataType = "String", value = "备忘录配置id", paramType = "path")
    })
    Result<MemoConfigVO> findById(String memoConfigId);


    /**
     * 查询备忘录配置
     * @param memoConfigQuery 备忘录配置查询参数
     * @return page
     */
    @ApiOperation(value="查询备忘录配置")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "memoConfigQuery", dataType = "MemoConfigQuery", value = "备忘录配置查询参数", paramType = "query")
    })
    Result<List<MemoConfigListVO>> listAll(MemoConfigQuery memoConfigQuery);


     /**
     * 分页查询备忘录配置
     * @param memoConfigQuery 备忘录配置查询参数
     * @return page
     */
    @ApiOperation(value="分页查询备忘录配置")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "memoConfigQuery", dataType = "MemoConfigQuery", value = "备忘录配置查询参数", paramType = "query")
    })
    Result<Page<MemoConfigListVO>> page(MemoConfigQuery memoConfigQuery);


}

